Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(telemetry): add configurability of span attributes in logs #5867

Merged
merged 6 commits into from
Aug 26, 2024
Merged

feat(telemetry): add configurability of span attributes in logs #5867

merged 6 commits into from
Aug 26, 2024

Conversation

bnjjj
Copy link
Contributor

@bnjjj bnjjj commented Aug 22, 2024 •
edited by BrynCooke
Loading

The telemetry.exporters.logging.stdout.format.json.span_attributes option is useful if you don't want to display all spans attributes but only some of them. It takes an array of attribute name to include as a root logging attribute.
This will search for the first attribute in the list of span attributes from the root span to the current one and attach it to the outmost json object for the log event.
If you set the same attribute on different spans at different level, then the identical attribute from child spans will take precedence over the one found previously in parent spans.

For example, if you have spans that contains span_attr_1 attribute and you only want to display this span attribute:

telemetry:
  exporters:
     logging:
       stdout:
         enabled: true
         format: 
           json:
             display_span_list: false
             span_attributes:
             - span_attr_1

Example output with a list of spans:

{
  "timestamp": "2023-10-30T14:09:34.771388Z",
  "level": "INFO",
  "fields": {
    "event_attr_1": "event_attr_1",
    "event_attr_2": "event_attr_2"
  },
  "target": "event_target",
  "span_attr_1": "span_attr_1"
}

Fixes #5540

ROUTER-418
Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this. ↩

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples. ↩

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions. ↩

@bnjjj
feat(telemetry): add configurability of span attributes in logs
0a59984 
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
@bnjjj bnjjj requested review from a team as code owners August 22, 2024 14:11
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@router-perf
Copy link

router-perf bot commented Aug 22, 2024

CI performance tests

  • const - Basic stress test that runs with a constant number of users
  • demand-control-instrumented - A copy of the step test, but with demand control monitoring and metrics enabled
  • demand-control-uninstrumented - A copy of the step test, but with demand control monitoring enabled
  • enhanced-signature - Enhanced signature enabled
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_big_cap_high_rate_callback - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity using callback mode
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • extended-reference-mode - Extended reference mode enabled
  • large-request - Stress test with a 1 MB request payload
  • no-tracing - Basic stress test, no tracing
  • reload - Reload test over a long period of time at a constant rate of users
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • step-local-metrics - Field stats that are generated from the router rather than FTV1
  • step-with-prometheus - A copy of the step test with the Prometheus metrics exporter enabled
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • xxlarge-request - Stress test with 100 MB request payload

@bnjjj
changelog
1e46cf6 
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
@bnjjj bnjjj requested review from garypen, Geal and BrynCooke August 22, 2024 14:14
bnjjj added 3 commits August 22, 2024 16:25
@bnjjj
fix lint
9d7f89f 
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
@bnjjj
fix test
e3686db 
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
@bnjjj
update snapshot
23a8e2a 
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
BrynCooke
BrynCooke approved these changes Aug 22, 2024
View reviewed changes
Copy link
Contributor

@BrynCooke BrynCooke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, let's get @shorgi to look at the docs text!
I like that you could use the config to show attribute overriding

@bnjjj bnjjj requested a review from shorgi August 22, 2024 15:18
shorgi
shorgi reviewed Aug 22, 2024
View reviewed changes
docs/source/configuration/telemetry/exporters/logging/stdout.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/exporters/logging/stdout.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/exporters/logging/stdout.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/exporters/logging/stdout.mdx Show resolved Hide resolved
docs/source/configuration/telemetry/exporters/logging/stdout.mdx Show resolved Hide resolved
docs/source/configuration/telemetry/exporters/logging/stdout.mdx
enabled: true
format:
json:
display_span_list: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should document the valid or recommended setting of display_span_list. I assume it's either recommended or required to be false?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's because usually when using span_attributes feature you probably don't want to display all the span list. Nothing prevents you from doing it, it's still valid but pretty useless

.changesets/feat_bnjjj_feat_5540.md Outdated Show resolved Hide resolved
.changesets/feat_bnjjj_feat_5540.md Outdated Show resolved Hide resolved
.changesets/feat_bnjjj_feat_5540.md Show resolved Hide resolved
.changesets/feat_bnjjj_feat_5540.md Show resolved Hide resolved
@bnjjj @shorgi
Apply suggestions from code review
7e19da5 
Co-authored-by: Edward Huang <edward.huang@apollographql.com>
@bnjjj bnjjj requested a review from shorgi August 23, 2024 09:07
@bnjjj bnjjj merged commit 0cc94c1 into dev Aug 26, 2024
14 checks passed
@bnjjj bnjjj deleted the bnjjj/feat_5540 branch August 26, 2024 15:17
lrlna pushed a commit that referenced this pull request Aug 28, 2024
@bnjjj @shorgi @lrlna
feat(telemetry): add configurability of span attributes in logs (#5867)
0c610e3 
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
Co-authored-by: Edward Huang <edward.huang@apollographql.com>
@abernix abernix mentioned this pull request Sep 10, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BrynCooke BrynCooke BrynCooke approved these changes

@garypen garypen Awaiting requested review from garypen

@Geal Geal Awaiting requested review from Geal

@shorgi shorgi Awaiting requested review from shorgi

Assignees

@bnjjj bnjjj

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Configurability of log attributes
3 participants
@bnjjj @BrynCooke @shorgi